home *** CD-ROM | disk | FTP | other *** search
/ The Fatted Calf / The Fatted Calf.iso / Applications / Graphics / GraphicsWorkshop / Source / Converters / pbm.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-02-15  |  8.1 KB  |  200 lines
  1. /*
  2.  * This is perhaps one of the most important objects. It's what deals with reading and
  3.  * writing the bitmaps to and from disk. When used init and free should always be called.
  4.  * The concept of sender is used in a couple of places in this object and should respond to
  5.  * the following request: It should respond to getImageCon and return the id of a ImageControl 
  6.  * object. Note that the NXBitmapImageRep links this from disk at run time. You may also
  7.  * do this, should you wish, or you may define your own set of internal routines. Whatever
  8.  * you do, the ImageControl object should respond to everything defined in image.h, and
  9.  * these should have predictable results.
  10.  */
  11.  
  12. #ifndef __PBMCONVERT__
  13. #define __PBMCONVERT__
  14.  
  15. #import <Converter.h>
  16.  
  17. #define CONVERT_ERR_NONE        0
  18. #define CONVERT_ERR_WARNING    1
  19. #define CONVERT_ERR_FATAL        2
  20.  
  21. #define ERROR_NO_ERROR            0
  22. #define ERROR_UNABLE_TO_OPEN    1
  23. #define ERROR_PERMISSION_DENIED    2
  24. #define ERROR_BAD_FORMAT        3
  25. #define ERROR_TRUNCATED_FILE    4
  26. #define ERROR_NEEDSWINDOWSERV    5
  27. #define ERROR_UNABLETOLINK        6
  28. #define ERROR_UNKNOWN            7
  29.  
  30. @interface PBM : Converter
  31. {
  32. }
  33.  
  34. /*
  35.  * Initializes the object. This need not necessarily be used, but you can use it if you'd like.
  36.  * Assumes:     Nothing
  37.  * Returns:    self
  38.  * Results:    A new object is up and running.
  39.  */
  40. - init;
  41.  
  42. /*
  43.  * Frees anything used by the object.
  44.  * Assumes:    Object is instantiated.
  45.  * Results:     It is no longer valid to message the object.
  46.  */
  47. - free;
  48.  
  49. /*
  50.  * Reads the bitmap from stream. 
  51.  * Assumes:    The object has been instantiates, stream is an valid stream opened for at least
  52.  *            reading. Sender is the id of whatever object is calling the converter. 
  53.  * Returns:    id of an NXBitmapImageRep or nil if the image was unable to be read.
  54.  */
  55. - readFromStream: (NXStream *)stream from: sender;
  56.  
  57. /*
  58.  * Write the bitmaps id to stream.
  59.  * Assumes:    Object has been instantiated. At times, it's best to have used a call to the
  60.  *             save panel first, since this can set internal variables, but it's not necessary.
  61.  *            stream should be a valid NXStream opened for at least writing. Sender should
  62.  *            be the id of the caller. id is a NXBitmapImageRep, or something that responds
  63.  *            to all the message of the NXBitmapImageRep.
  64.  * Returns:    YES if the image was sucessfully writing, otherwise it returns NO.
  65.  */
  66. - (BOOL)write: (id)image toStream: (NXStream *)stream from: sender;
  67.  
  68. /*
  69.  * Similar to readFromStream but will read multiple images from a stream when present.
  70.  * Assumes:     Object instantiated. stream valid for reading. sender is id of caller.
  71.  * Returns:    id of an NXImage or nil if unable to read the image. It should return a single
  72.  *            image in the least, even for formats that don't support multiple images.
  73.  */
  74. - readAllFromStream: (NXStream *)stream from: sender;
  75.  
  76. /*
  77.  * Reverses the process of read all.
  78.  * Assumes:     Object instantiates. id is to an NXImage or something that responds to all of
  79.  *            NXImage's methods. stream is valid for writing. This should always attempt
  80.  *            to write at least one image to disk (the first usually) even for formats that 
  81.  *            don't support multiple images.
  82.  * Returns:    YES if the image is sucessfully written to disk.
  83.  */
  84. - (BOOL)writeAll: (id)image toStream: (NXStream *)stream;
  85.  
  86. /*
  87.  * Creates and lays out a custom view that the converter can use to set customization
  88.  * parameters. 
  89.  * Assumes:     Object instantiated and the window server is running. width should be the
  90.  *            maximum width the custom view can be.
  91.  * Returns:    id of a parent view or nil if this object doesn't use one.
  92.  */
  93. - customSaveView: (int)width;
  94.  
  95. /*
  96.  * This is very similar to customSaveView, however, it is used to set parameters for
  97.  * the run time loading of images. This object does not support input custom views.
  98.  * Assumes:     Object instantiated and the window server is running. width should be the
  99.  *            maximum width the custom view can be.
  100.  * Returns:    id of a parent view or nil if this object doesn't use one.
  101.  */
  102. - customOpenView: (int)width;
  103.  
  104. /*
  105.  * Returns the name of the current format, ie, the gif converter returns the string "Graphics
  106.  * Interchange Format (GIF)".
  107.  * Assumes:     Object has been instantiated.
  108.  * Returns:    A pointer to a string. The caller should always use something like strcpy to
  109.  *            get a copy of the string, since it's life is only guaranteed for the life of the
  110.  *            object.
  111.  */
  112. - (char *)getFormatName;
  113.  
  114. /*
  115.  * This is a simple interface to setting custom values of various parameters. There are
  116.  * no standards for what a converter must take of these values, so while the converter
  117.  * will tell you whether it took the value you or not, you, as the programmer, should
  118.  * not get upset when a parameter is not taken. Likewise, should the converter receive
  119.  * a request to set a parameter it does not understand, it should always refuse it with
  120.  * grace (ie, make it idiot proof.) What parameters an indivudual converter will take
  121.  * should be documented somewhere with the converters distribution.
  122.  * Assumes:    The converter is instantiated, parameter is a NULL terminated character
  123.  *            string, and ptr is a pointer to the data type. This is determined by patameter.
  124.  * Returns:    YES if the value was set, NO if the setting failed for any reason.
  125.  */
  126.  - (BOOL)setCustomParameter: (const char *)parameter withValue: (void *)ptr;
  127.  
  128. /*
  129.  * Gets a custom parameter value. See above about support for this call, as it's similar
  130.  * to setCustomParameter. Mainly, the converter should not crash when a request for
  131.  * a non-existant parameter is made.
  132.  * Assumes:     The converter is instantiated and parameter is a NULL terminater char-
  133.  *            acter string.
  134.  * Returns:    A pointer to the parameter (type depends on return value) or nil if the
  135.  *            parameter is not understood.
  136.  */
  137.  - (void *)getCustomParameter: (const char *)parameter;
  138.  
  139.  /*
  140.   * Returns a string with copyright information, name of the author, where the author
  141.   * can be reached, etc. This should only be a couple of lines, so keep it short and 
  142.   * sweet. An example might be:
  143.   * "My Image Format Converter\nby Joe Programmer\nCopyright R'N'R Software\n ...
  144.   * ... email bugs to jprogramm@system.there.edu"
  145.   * Assumes:     Converter linked and instantiated.
  146.   * Returns:    A pointer to a null terminated string. This string must be non volatile for
  147.   *             the life of the converter. Ie, as long as the programmer keeps a converter
  148.   *            linked, the pointer should be valid.
  149.   */
  150.  - (char *)copyrightNotice;
  151.  
  152.  /*
  153.   * Returns the current error state of the converter.
  154.   * Assumes:     Converter has been instantiated.
  155.   * Returns:    0 = CONVERT_ERR_NONE         Signals no error
  156.   *            1 = CONVERT_ERR_WARNING   Signals action taken, but not one expected.
  157.   *            2 = CONVERT_ERR_FATAL          Signals no action taken.
  158.   */
  159.  - (int)errorState;
  160.  
  161.  /*
  162.   * Returns an int describing the current error message.
  163.   * Assumes:    Converter instantiated.
  164.   * Returns:    An int describing the error type. See defines for integers returned.
  165.   */
  166.  - (int)errorMessage;
  167.  
  168.  /*
  169.   * This provides support for non standard error messages. It's preferable for programmers
  170.   * to avoid this message, but in special cases where you need to express something unique,
  171.   * it is appropiate. Just remember, that the use of this message disables multilingual
  172.   * support.
  173.   * Assumes:    Converter Instantiated
  174.   * Returns:    NULL terminated string describing the error.
  175.   */
  176.  - (char *)errorStringMessage;
  177.  
  178.  /*
  179.   * This method returns YES if the converter requires the window server. Ideally, converters
  180.   * should not depend on the window server, but sometimes this cannot be avoided. For 
  181.   * example, a programmer wouldn't be expect to write a PostScript interpreter just to read
  182.   * in eps files. Note, however, that returning YES will result in the converter not working
  183.   * with command line versions of applications.
  184.   * Assumes:    Converter Instantiated
  185.   * Returns:    YES is window server is needed, NO otherwise.
  186.   */
  187. - (BOOL)needsWindowServer;
  188.  
  189. /*
  190.  * Returns a string in the form <major version>.<minor version>. This is used by 
  191.  * the calling program to see what level or protocol the object will respond to. 
  192.  * Assumes:    Converter instantiated.
  193.  * Returns:    A null terminated string in the form <major version>.<minor version>.
  194.  *            For example, 1.0.
  195.  */
  196. - (char *)protocolVersion;
  197.  
  198. @end
  199.  
  200. #endif